docs(jetstream_consumers): Document ability to set JetStream consumer configuration#52
Open
nullmoose wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the README to document how JetStream consumer configuration can be provided to Leopard, and links to the upstream NATS JetStream consumer configuration reference.
Changes:
- Add an AsciiDoc attribute/link to the JetStream consumer configuration docs.
- Document passing JetStream consumer options via snake_case keys with noted exceptions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+120
to
+123
| Any configuration options available for JetStream consumers can be passed via snakeified keys | ||
| in the `consumer` hash, with the exception of `durable_name`, `filter_subject` and `ack_policy`. | ||
| `durable_name` and `filter_subject` are both derived from the endpoint, and `ack_policy` is always | ||
| set to `explicit`. |
Author
There was a problem hiding this comment.
There's already an example key present in the existing example code above this change. Should already be clear imo
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates docs to make clear how to configure JetStream consumers